docs: fix wire-contract doc inaccuracies from post-merge review#75
Merged
Conversation
- CHANGELOG downgrade claim was backwards: 0.13-written files DO load in older versions — with silent data loss (cache/total counts read 0; errorMessage/providerMetadata incl. Gemini thought signatures dropped). Documented the real failure mode. - serde floor corrected to 1.0.177, the release that actually added rename_all_fields (verified against serde release history; 1.0.181 matched no meaningful boundary). Floor build verified. - persistence.md JSON example still showed pre-0.13 snake_case usage keys — updated with a load-compat note. - messages-events.md: accumulation must reset at each MessageStart (mid-stream provider retry emits a fresh MessageStart with no closing MessageEnd); placeholder phrasing corrected. - serialization_test: EVENT_VARIANT_COUNT assertion closes the unenforced half of the freeze promise (variant added to the match without a sample in all_agent_events now fails the test). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Comment-accuracy review of the merged #72 found three factual errors and two enforcement gaps:
errorMessage/providerMetadata— including Gemini thought signatures — lost). Silent corruption is the more dangerous failure mode to leave undocumented; now stated.rename_all_fieldsshipped in 1.0.177 (July 2023), not 1.0.186 nor 1.0.181. Floor lowered to the real boundary; verified the crate builds+tests at exactly 1.0.177.cache_read/cache_write/total_tokens.MessageStartwith no closingMessageEnd; clients must reset accumulation atMessageStartor they duplicate replayed text.EVENT_VARIANT_COUNTassertion fails when a variant is added to the match without a sample inall_agent_events(previously the new variant's tag/round-trip went silently untested).Verified: 393 tests green at both serde 1.0.177 (floor) and latest; clippy
-Dwarningsclean.🤖 Generated with Claude Code